IAxis.TouchProbe method

Records the position of an axis at a trigger event.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IKsCommand<double> TouchProbe(
       McProbeTrigger triggerInput,
       bool windowOnly,
       double firstPosition,
       double lastPosition
)

Function TouchProbe(
       triggerInput As McProbeTrigger,
       windowOnly As Boolean,
       firstPosition As Double,
       lastPosition As Double
) As IKsCommand(Of Double)

Parameters

triggerInput

Type: McProbeTrigger

The trigger signal source. Trigger input may be specified by the Index.

windowOnly

Type: bool

If set, only the value in the window will be used to trigger events. The window is the range between firstPosition and lastPosition.

firstPosition

Type: double

The start position from where (positive direction) trigger events are accepted (in user units). The value included in window. Currently, firstPosition must be less than lastPosition.

lastPosition

Type: double

The end position of the window (in user units). The value included in window.

Return value

Type: IKsCommand and IKsCommand<double>

Returns the states of touchprobe and a double value.

Remarks

To use this method, touch probe must be enabled using ISubsytem.TouchProbe.
One method instance should represent exactly one probing command.
In case of multiple instances on the same probe and axis, the elements of McProbeTrigger should be extended with TouchProbeId, the identification of a unique probing command, which can be linked to IKsCommand.Abort.
After TouchProbe is done, you need to wait one cycle for the touch probe to take effect.
For further details about how touch probe works, see Concepts > Touch probe.